/*
 * Copyright 2022 Haulmont.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.jmix.flowui.component;

import org.springframework.lang.Nullable;

import java.time.ZoneId;

/**
 * Defines a contract for components that support working with a {@link ZoneId}.
 * <p>
 * Implementations of this interface allow getting and setting a time zone identifier,
 * typically for handling date or time-related values with respect to a specific time zone.
 */
public interface HasZoneId {

    /**
     * Returns the {@link ZoneId} associated with this component.
     *
     * @return the {@link ZoneId} of this component, or {@code null} if no ZoneId is set
     */
    @Nullable
    ZoneId getZoneId();

    /**
     * Sets the {@link ZoneId} for this component.
     *
     * @param zoneId the {@link ZoneId} to be set for this component,
     *               or {@code null} to unset the current ZoneId
     */
    void setZoneId(@Nullable ZoneId zoneId);
}
